Einhugur Xml Plugin for Xojo

EinhugurXml.Document Class (console safe)

Class to represent Xml document.

Document is the owner of the entire document structure.

EinhugurXml.Node
   Document

class EinhugurXml.Document

Constructors

DocumentA default constructor which takes no parameters.

Properties

Empty (Inherited) Returns true if the Attribute is empty.
Name (Inherited) Sets or gets the name of the node.
TextValue (Inherited) This property is like a smart macro to do the complicated thing of getting Text value from a child Text node, and it will get the text without drilling down onto the Text node.
Type (Inherited) Returns type of the node.
Value (Inherited) Sets or gets value for Nodes that can have values.

Methods

AppendAttribute (Inherited) Appends new attribute to the node.
AppendChild (Inherited) Appends a child with a given name to the node, returning the newly created node.
AppendChild (Inherited) Appends a child node of given type to the node, returning the newly created node.
AppendCopy (Inherited) Copies the specified attribute to become a attribute of this node by appending it.
AppendCopy (Inherited) Copies the specified node to become a child of this node by appending it.
AppendMove (Inherited) Moves the specified node to become a child of this node by appending it.
Attribute (Inherited) Returns attribute by name or empty attribute if not found, unless if the create parameter is true then if not found a newly appended attribute will be returned.
Child (Inherited) Returns first child by a given name, or empty node if not found, unless if the create parameter is true then if not found a newly appended node will be returned.
ChildValue (Inherited) Returns the value of the first child with type NODE_PCDATA or NODE_CDATA.
ChildValue (Inherited) Wrapper shortcut for Child(name).ChildValue()
Children (Inherited) Returns iterator for all child nodes of the node.
Children (Inherited) Returns iterator for all children of the node with a given name.
shared DateTimeToISO8601Converts DateTime to ISO-8601 date time which is suitable for Xml.
shared DateToISO8601Converts DateTime to ISO-8601 date which is suitable for Xml.
DocumentElement Gets the element node that’s the immediate child of the document.
FindChildByAttribute (Inherited) Finds child node by Attribute value without evaluating node names.
FindChildByAttribute (Inherited) Finds child node by Attribute value within set of nodes with specific name.
FirstAttribute (Inherited) Returns first attribute on the node.
FirstChild (Inherited) Returns first child node.
FirstElementByPath (Inherited) Finds first node in the tree by given path, returning the found element or empty node.
shared FromFileLoads document from file, returning EinhugurXml.Document.
shared FromStringLoads document from string, returning EinhugurXml.Document.
shared ISO8601ToDateTimeConverts string containing ISO8601 formatted date to DateTime.
InsertAttributeAfter (Inherited) Inserts attribute after other attribute.
InsertAttributeBefore (Inherited) Inserts attribute before other attribute.
InsertChildAfter (Inherited) Inserts child with given name after a specific child node.
InsertChildAfter (Inherited) Inserts child of specific type after a specific child node.
InsertChildBefore (Inherited) Inserts child with given name before a specific child node.
InsertChildBefore (Inherited) Inserts child of specific type before a specific child node.
InsertCopyAfter (Inherited) Copies the specified attribute to become a attribute of this node by inserting the node after a specific attribute.
InsertCopyAfter (Inherited) Copies the specified node to become a child of this node by inserting the node after a specific node.
InsertCopyBefore (Inherited) Copies the specified attribute to become a attribute of this node by inserting the node before a specific attribute.
InsertCopyBefore (Inherited) Copies the specified node to become a child of this node by inserting the node before a specific node.
InsertMoveAfter (Inherited) Moves the specified node to become a child of this node by inserting the node after a specific node.
InsertMoveBefore (Inherited) Moves the specified node to become a child of this node by inserting the node before a specific node.
LastAttribute (Inherited) Returns last attribute on the node.
LastChild (Inherited) Returns last child node.
NextSibling (Inherited) Returns next sibling node.
NodeAttributes (Inherited) Returns iterator for attributes on the node.
Operator_Compare (Inherited) Compares if nodes are the same node under the hood.
Parent (Inherited) Returns the parent node or empty node if there was no parent.
PrependAttribute (Inherited) Prepends new attribute to the node.
PrependChild (Inherited) Prepends a child with a given name to the node, returning the newly created node.
PrependChild (Inherited) Prepends a child node of given type to the node, returning the newly created node.
PrependCopy (Inherited) Copies the specified attribute to become a attribute of this node by prepending it.
PrependCopy (Inherited) Copies the specified node to become a child of this node by prepending it.
PrependMove (Inherited) Moves the specified node to become a child of this node by prepending it.
PreviousSibling (Inherited) Returns previous sibling node.
RemoveAllAttributes (Inherited) Removes all attributes from the node, returning true if successful.
RemoveAllChildren (Inherited) Removes all child nodes from the node, returning true if successful.
RemoveAttribute (Inherited) Removes attribute.
RemoveAttribute (Inherited) Removes attribute by name, returning true if attribute was removed, else false.
RemoveChild (Inherited) Removes child node by name, returning true if successful.
RemoveChild (Inherited) Removes child node, returning true if successful.
Root (Inherited) Returns the root node.
SaveToFileSaves the document to file.
SaveToFileSaves the document to file, taking in custom format flags. See constants on the EinhugurXml module.
SelectNode (Inherited) The SelectNode function compiles the XPath expression and then executes it with the node as a context node, and returns the result as a single XPathNode, the node that makes the first hit. The function can optionally take in XPath variables.
SelectNodes (Inherited) The SelectNodes function compiles the XPath expression and then executes it with the node as a context node, and returns the resulting node set. The function can optionally take in XPath variables.
Text (Inherited) Returns TextHelper class to read or write a Text node, optionally creating new text node if it does not exist.
ToStringOutputs the entire Xml document out as string.
ToStringOutputs the entire Xml document out as string, taking in custom format flags. See constants on the EinhugurXml module.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit
  • iOS